Documentation Inheritance in Literate Programs
نویسندگان
چکیده
Object-oriented programming has resulted in the reuse of class libraries and application frameworks. This can considerably improve the productivity in software development. Black-box reuse boosts productivity more than white-box reuse. However, white-box reuse is the usual means of dealing with common parts in di erent applications, assuming that the same developers are building these applications or they somehow know about these common-
منابع مشابه
The CLiP Style of Literate Programming
Literate programming is a method to integrate programs with their documentation. Compilable modules are no separate entities, but they are extracted from the documentation. Most literate programming tools use explicit commands in the formatter input files to guide the extraction process. The CLiP approach presented in this paper relies on coding style instead. This makes the code extraction com...
متن کاملWriting Literate Proofs with XML Tools
Both mechanical proof scripts and programs benefit from documentation and modularity. Designed to be an industrial-strength theorem prover, ACL2 provides powerful support for both of these. The standard distribution includes hundreds of pages of documentation that are automatically generated from function doc-strings in the source code. However, it is still difficult to write easily understanda...
متن کاملModel Self-Assessment of Writing Principles Principle 3: Agents, Actions, and Objects
We used literate programming on a team project to write a 33,000-line program for the Synthesizer Generator. The program, Penelope, was written using WEB, a tool designed for writing literate programs. Unlike other WEB programs, many of which have been written by WEB’s developer or by individuals, Penelope was not intended to be published. We used WEB in the hope that both our team and its fina...
متن کاملLiterate Programming in Forth
We look at Donald Knuth's concept of \Literate Programming," investigating exactly what it is and how it is used to assist conventional programmers. We then ask what lessons we can learn from this idea and if it is possible to apply them to Forth. We look at the alterations needed to the system and/or Forth to allow us to take advantage of this system. Indeed do we obtain all of the advantages ...
متن کاملDOCUMENTING AND MAINTAINING MODULA-2 PROGRAMS WITH DOgMA
DOgMA is a software tool that supports the documentation and maintenance of Modula–2 programs. The tool combines the concepts of hypertext and literate programming to deliver powerful support of the comprehension process. DOgMA can be used to develop new programs, to explore or document existing ones, and to develop source code and documentation in parallel. The paper presents the concepts used...
متن کامل